A graphical list box. More...
Classes | |
class | Item |
Public Member Functions | |
ListBox () | |
~ListBox () | |
Item * | getItemFromLabel (const std::string_view &label) const |
Item * | getItemFromData (void *data) const |
Item * | getItemFromIndex (unsigned int index) const |
virtual Item * | getCurrentSelection () const |
virtual int | getCurrentSelectionIndex () const |
listBoxSelectionCallback | getSelectionSpecializedCallback () const |
unsigned int | getItemCount () const |
void | setSelectionSpecializedCallback (listBoxSelectionCallback value) |
virtual Item * | insertItem (const std::string_view &text, void *data) |
virtual void * | deleteItem (const std::string_view &name) |
virtual void | changeItemLabel (const std::string_view &oldText, const std::string_view &newText) |
void | changeItemData (const std::string_view &text, void *newData) |
virtual bool | setSelected (const std::string_view &text) |
virtual bool | setSelectedIndex (unsigned int index) |
bool | setSelectedData (void *data) |
virtual void | clearItems () |
virtual void | exportIntrospection (nkExport::Node *rootNode) override |
virtual void | importClassFromTree (nkExport::Node *rootNode) override |
![]() | |
Component () | |
virtual | ~Component () |
Layout * | getLayout () const |
nkMaths::Point | getPositionInParent () const |
nkMaths::Point | getPositionInScreen () const |
int | getWidth () const |
int | getHeight () const |
nkMaths::Rectangle | getArea () const |
virtual nkMaths::Point | getBorderExtents () const |
virtual int | getLayoutAllowedWidth () const |
virtual int | getLayoutAllowedHeight () const |
virtual int | getLayoutAllowedOffsetX () const |
virtual int | getLayoutAllowedOffsetY () const |
bool | isInitialized () const |
Component * | getParentComponent () const |
COMPONENT_TYPE | getComponentType () const |
const char * | getComponentName () const |
bool | getVisibility () const |
virtual const char * | getLabel () const |
void * | getData () const |
bool | isEnabled () const |
bool | isForegroundWindow () const |
unsigned int | getZDepth () const |
bool | getVisibleOnLoad () const |
virtual Layout * | setLayout (LAYOUT_TYPE layoutType) |
virtual void | setPositionInParent (nkMaths::Point position) |
virtual void | setPositionInScreen (nkMaths::Point position) |
virtual void | setSize (int width, int height) |
virtual void | setWidth (int width) |
virtual void | setHeight (int height) |
void | setMinSize (unsigned int width, unsigned int height) |
void | setMaxSize (unsigned int width, unsigned int height) |
void | setRatio (float widthOverHeight) |
virtual void | setArea (nkMaths::Rectangle area) |
virtual void | setParentComponent (Component *parent, bool makeItVisible=true) |
virtual void | setLabel (const std::string_view &label) |
void | setComponentName (const std::string_view &name) |
virtual void | setVisibility (bool value) |
void | setData (void *data) |
void | setEnabled (bool value) |
void | setVisibleOnLoad (bool value) |
void | addChild (Component *child, bool makeItVisible=true) |
void | removeChild (Component *child) |
void | removeChild (unsigned int index) |
Component * | getChild (unsigned int index) |
unsigned int | getChildIndex (Component *child) |
void | unloadWithChildren () |
void | loadWithChildren () |
void | updateZDepth () |
void | bringToForeground () |
void | focusWindow () |
nkMaths::Point | getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords) |
nkMaths::Point | getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords) |
virtual void | load ()=0 |
virtual void | unload ()=0 |
virtual void | updateWindow () |
nkImages::Image | paintToImage () |
void | onSized () |
ContextMenu * | createContextMenu () |
ContextMenu * | getCurrentContextMenu () |
void | shutContextMenu () |
virtual void | exportClassToTree (nkExport::Node *rootNode) override |
![]() | |
Exportable () | |
virtual | ~Exportable () |
A graphical list box.
nkWinUi::ListBox::ListBox | ( | ) |
Constructor.
nkWinUi::ListBox::~ListBox | ( | ) |
Destructor.
Item* nkWinUi::ListBox::getItemFromLabel | ( | const std::string_view & | label | ) | const |
label | The label of the item to find. |
Item* nkWinUi::ListBox::getItemFromData | ( | void * | data | ) | const |
data | The data of the item to find. |
Item* nkWinUi::ListBox::getItemFromIndex | ( | unsigned int | index | ) | const |
index | The index of the item to find. |
|
virtual |
|
virtual |
listBoxSelectionCallback nkWinUi::ListBox::getSelectionSpecializedCallback | ( | ) | const |
unsigned int nkWinUi::ListBox::getItemCount | ( | ) | const |
void nkWinUi::ListBox::setSelectionSpecializedCallback | ( | listBoxSelectionCallback | value | ) |
Sets the selection callback. Will be called over the one set in the InputSystem.
value | The callback to use. |
|
virtual |
|
virtual |
Erases an item from the list. Memory linked will be freed.
name | The name of the item to free. |
|
virtual |
Changes a label attached to an existing item.
oldText | The old label of the item to change. |
newText | The new label to set for the item. |
void nkWinUi::ListBox::changeItemData | ( | const std::string_view & | text, |
void * | newData | ||
) |
Changes the data attached to an existing item.
text | The label of the item to change. |
newData | The new data to attach to the item. |
|
virtual |
Selects an item.
text | The label of the item to select. |
|
virtual |
Selects an item.
index | The index of the item to select. |
bool nkWinUi::ListBox::setSelectedData | ( | void * | data | ) |
Selects an item.
data | The attached data the item to select has. |
|
virtual |
Clears all items in the list box. Memory will be freed.
|
overridevirtual |
See Component::exportIntrospection().
Reimplemented from nkWinUi::Component.
|
overridevirtual |
See Component::importClassFromTree().
Reimplemented from nkWinUi::Component.